perm filename SILISP.DOC[NET,KMC] blob sn#166725 filedate 1975-07-05 generic text, type T, neo UTF8
		UCI-TENEX LISP MAINTENANCE INFO
		T. M. Wolpert for IMSSS, 09-09-74

The UCI-TENEX LISP system contains an interpreter, a compiler and
an MLISP translator/compiler.  The following files (in directory
<ILISP> unless otherwise noted) make up the running system.

<SUBSYS>ILISP.SAV	sharable interpreter.
TNXLSP.DDT		DDT overlay for use by GETDDT function.
TNXLSP.LOD		loader overlay for use by LOAD function.
TNXLSP.SYM		symbol table for use by LOAD function.
HELP.FILENDX		HELP system file index.
HELPTEXT.A		HELP system text files in a format
HELPTEXT.B		  suitable for use by HELP system
HELPTEXT.E
HELPTEXT.E0
HELPTEXT.E1
HELPTEXT.I
HELPTEXT.L
HELPTEXT.M
HELPTEXT.P
HELPTEXT.P1
TNXLSP.GRIPE		output file for HELP GRIPE command.

TNXCMP.SAV		sharable compiler.

MLISPC.SAV		sharable MLISP translator/compiler.


RUNFILEs are provided for creating the .SAV files.

To create:	RUNFILE using:		Notes:
TNXLSP.SAV	TNXLSP.RNF		RENAME to <SUBSYS>ILISP.SAV
TNXLSP.DDT
TNXLSP.SYM
TNXLSP.BOOT				This is a 'naked' UCI-TENEX LISP
					system (before bootstrap).  If 
					there are no changes to TNXLSP.MAC,
					you can boot a new system from
					here via the runfile TNXLS1.RNF.

TNXCMP.SAV	TNXCMP.RNF		Create <SUBSYS>ILISP.SAV first.

MLISPC.SAV	MLISPC.RNF		Create <SUBSYS>ILISP.SAV first.

The files required for creation of the system are as follows.
In the via column, blank means that the given file IS the basic
file, --- means that the given file can't be recreated at IMSSS,
and *** means that the creation process is multi-step.  In general,
it is a bad idea to recompile .LSP files into the .LAP files.
Idiot or idiots unknown have corrected the LAP until it works -
by hand, without correcting the corresponding LISP code.
If the dir nams? column contains *, the ultimate source for the
file contains directory names which must be changed if the ILISP
system directory is other than <ILISP>.

To make		you need	via	from		    dir nams?
interpreter	TNXLSP.REL or 	MACRO	TNXLSP.MAC		*
		TNXLSP.BOOT and ***
		TNXSYM.SAV	***	TNXSYM.FAI
		TNXLAP		---				*
		EDIT.LAP	CMPL	EDIT.LSP
		ERRORX.LAP	CMPL	ERRORX.COM
		TNXSYS1.LAP	CMPL	TNXSYS1.LSP
		BREAK.LAP	---
		ERRORX.LSP
		SUBSYS.LAP
		NEWHELP.LAP	CMPL	NEWHELP.LSP		*
		TNXFNS.LAP
		DDT.LAP						*
		TNXSYS2.LSP

compiler	interpreter
		COMPLR.LAP	CMPL	COMPLR.LSP
		COMFIX.LSP
		TNXCMPLR1.LAP 	EDIT	COMPLR.LAP


MLISP		interpreter
		MLISP.LAP	CMPL	MLISP.LSP
		RUNFN1.LAP	CMPL	RUNFN1.LSP
		MINIT
		UTILS		COPY	RUNFN2.LAP, ACHLOC, SETQS
		PPRINT.LAP	CMPL	PPRINT.LSP
		COMPLR.LAP	CMPL	COMPLR.LSP
		TNXCMPLR1.LAP	EDIT	COMPLR.LAP
		SCAN.REL	MACRO	SCAN.MAC
Creation procedures not covered in the runfiles are as follows.		

For TNXLSP.REL

@MACRO
*TNXLSP/P/P/P←TNXLSP
...
*↑C

**************************************************************

For TNXLSP.LOD

@MACRO
*TNXLOD←TNXLOD
...
*↑C
@LOADER
*TNXLOD<altmode>
...
@START
TNXLSP.LOD CREATED.

**************************************************************

For TNXSYM.SAV

@FAIL
*TNXSYM←TNXSYM
*↑C
@LOADER
*TNXSYM<altmode>
...
@DDT
17/ ...  140,,750000
BLT 17,750777<altmode>X
HALTF<altmode>X
@SSAVE 750 750 TNXSYM


The HELPTEXT files have a discipline all their own.  The are created
from the corresponding HELP files as follows.

@ILISP
UCI-TENEX LISP mm-dd-yy
Type (HELP) for help.

*(DSKIN HELPMAINT]
HELPMAINT
FILECOPY
DOTOPIC
FILES-LOADED
*(FILECOPY]
Input file? .(HELP.x]
Output file? .(HELPTEXT.x]
Copied and closed!

T
*(EXIT]

If the input file is incorrectly formatted, FILECOPY will complain:
Last major: <topic>
Last minor: <subtopic>
File format error!!
Closed incomplete file...

<topic> is a topic name and <subtopic> is a subotpic name.  These
were in the last header detected in the input file, before the
format error occurred.

The HELP files are maintained with any text editor.  Topics (and
subtopics within topics) appear in alphabetical order.  Each
entry on the file is of the following form:

# topic subtopic

##
"text for this topic-subtopic pair, just as you wish it to appear"

Double-quote (") may not appear in the text!!

The ##-"text string" entries may be repeated as desired within a
topic-subtopic pair.  Each such entry represents a separately
addressable text block.  Presently, the HELP system simply displays
all blocks for a given topic-subtopic.  The ability to have
multiple blocks is seen as a 'feature' for later expansion.

New subtopics of an existing topic may be added simply by making
the appropriate entries on the HELP file (and creating the
HELPTEXT file as explained above).  New topics must be added
to the HELP file and to the ##FILNDX variable on the file
HELP.FILENDX (and the HELPTEXT file must be created). 

The help text was split into multiple files in order to minimize
the size of the index which is required at any given time.
In adding new topics, this should be kept in mind.  New files
should be created as needed and added to ##FILNDX on HELP.FILENDX